CxFmsAlarmLogCtrl Properties

The CxFmsAlarmLogCtrl object contains the following properties.

General Properties

Browse by letter:     [A]     [B]     [C]     [D]     [E]     [F]     [I]     [P]     [S]     [U]    

Property SubType Read Only Description

Appearance

Integer

No

Returns/sets the appearance of the object boundary

Possible values for this property are as follows.

  • 0 - Flat
  • 1 - 3D

Default value is 0 - Flat.

BeginDate

String

No

Note: This property is only used if the UseSessionOptions property is set to 0 - No.

Returns/sets the start date of data to display in the control

This string can be in one of the following forms.

  • Absolute date - for example: 1/31/2023
  • Relative date - for example: T (today), T-14 (14 days prior to today), or T+1 (one day following today)

Default value is T-7.

See Selecting Date and Time for more information.

BorderStyle

Integer

No

Returns/sets the border style

Possible values for this property are as follows.

  • 0 - None
  • 1 - Fixed Single

Default value is 0 - None.

ChooserFilterString

String

No

Returns/sets the filter to be used, of the type specified by the ChooserFilterType property, when retrieving Nodes for selection

Wildcard values * (multiple character) and ? (single character) are supported. Wildcards can be used in any part of the string to specify that any character or set of characters is allowed in its place.

Example

A filter string of "*Test*" will retrieve all Nodes with the word "Test" somewhere in the string, such as "TestDevice" or "MyTestDevice" or "Device001Test". 

Default value is * (multiple character wildcard).

ChooserFilterType

Integer

No

Returns/sets the Node property type that will be filtered by the string specified in the ChooserFilterString property

Possible values for this property are as follows.

  • 0 - Name
  • 1 - Description
  • 2 - ID

Default value is 0 - Name.

ChooserGroupSelection

String

No

Returns/sets the group currently selected in the Node chooser’s Group combo box

ChooserPrimarySortColumn

Integer

No

Returns/sets the primary sort column of the Node chooser’s Node list

Possible values for this property are as follows.

  • 0 - Type ascending
  • 2 - Name ascending
  • 3 - Description ascending
  • 4 - Type descending
  • 5 - Name descending
  • 6 - Description descending

Default value is 2 - Name ascending.

ChooserSiteServiceSelection

String

No

Returns/sets the Site.Service currently selected in the Node chooser’s FMS combo box

ChooserSiteServiceVisible

Boolean

No

Returns/sets whether or not the Node chooser’s FMS combo box is visible

Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 1 - Yes.

CmdDefinitionXml

String

No

Returns/sets the XML specifying the custom FMS commands configured for the control  Another way to configure this property is to use the control’s property page.

DateFormat

Integer

No

Note: This property is only used if the UseSessionOptions property is set to 0 - No.

Returns/sets the format of dates shown in the control

Possible values for this property are as follows.

  • 0 - Device_Time
  • 1 - Contract_Time
  • 2 - Local_Time

Default value is 0 - Device_Time.

EndDate

String

No

Note: This property is only used if the UseSessionOptions property is set to 0 - No.

Returns/sets the ending date of data to display in the control

This string can be in one of the following forms.

  • Absolute date - for example: 1/31/2023
  • Relative date - for example: T (today), T-14 (14 days prior to today), or T+1 (one day following today)

Default value is T.

See Selecting Date and Time for more information.

FilterConfigXml

String

No

Returns/sets the XML string specifying the alarm source filter settings to use for data display in the control

Filter property options are Entry and User alarm log sources. See Configure Filter in the Using the Alarm Control topic for more information about available filter settings.

Possible values for these properties are as follows.

  • 0 - No
  • 1 - Yes

Default value is 1 - Yes for all options; Entry="1" User="1".

Another way to configure this property is to use the OCX Properties dialog box (click the Alarm Log tab, then Log source). 

Font

StdFont

No

Returns/sets the font used by the control

Click … to access the Font dialog box to make font selections.

Default value is MS Shell Dlg.

IsEditing

Boolean

Yes

Returns whether or not the user is currently editing data in the control

PITDateTime

String

No

Note: This property is only used if the UsePIT property is set to 1 - Yes.

Returns/sets the Point in Time date and time of the control

This string can be in one of the following forms.

  • Absolute Date/Time - for example: 1/31/2023 7:10:14 AM
  • Relative Date/Time - for example: y-1 m-2 d=15 H=5 M=30 S=0
  • Relative Day - which is an offset from the current day T, for example: T-10

Default value is T, date and time today.

See Using the Home Menu for more information about PIT mode.

SessionBeginDate

String

No

Note: This property is only used if the UseSessionOptions property is set to 1 - Yes.

Returns/sets the Session starting date for the time window displayed in the control

This string can be in one of the following forms.

  • Absolute date - for example: 1/31/2023
  • Relative date - for example: T (today), T-14 (14 days prior to today), or T+1 (one day following today)

See Selecting Date and Time for more information.

Note: Because Session options are universal to all FMS controls, this property can only be set via script during runtime, and the value is not saved to the control.

SessionDateFormat

Integer

No

Note: This property is only used if the UseSessionOptions property is set to 1 - Yes.

Returns/sets the Session date/time format for the time window displayed in the control

Possible values for this property are as follows.

  • 0 - Device_Time
  • 1 - Contract_Time
  • 2 - Local_Time

Note: Because Session options are universal to all FMS controls, this property can only be set via script during runtime, and the value is not saved to the control.

SessionEndDate

String

No

Note: This property is only used if the UseSessionOptions property is set to 1 - Yes.

Returns/sets the Session ending date for the time window displayed in the control

This string can be in one of the following forms.

  • Absolute date - for example: 1/31/2023
  • Relative date - for example: T (today), T-14 (14 days prior to today), or T+1 (one day following today)

See Selecting Date and Time for more information.

Note: Because Session options are universal to all FMS controls, this property can only be set via script during runtime, and the value is not saved to the control.

SessionNodeTag

String

No

Note: This property is only used if the UseSessionNode property is set to 1 - Yes.

Returns/sets the Session Node tag, which specifies the active Node in the control

This tag must be in the form SITE.SERVICE|ID (for example: TEST.FMS|2540).

Note: Because Session options are universal to all FMS controls, this property can only be set via script during runtime, and the value is not saved to the control.

ShadingBackColor

OLE_COLOR

No

Returns/sets the cell background color used in the control

See Shading Colors for more information about displaying this property.

Default value is 255.250.205 (pale yellow).

ShadingForeColor

OLE_COLOR

No

Returns/sets the text color used in the control

See Shading Colors for more information about displaying this property.

Default value is 0.0.0 (black).

ShowChooserPane

Boolean

No

Returns/sets whether or not the Chooser pane will be displayed in the control

Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 1 - Yes.

ShowOptionsPane

Boolean

No

Returns/sets whether or not the Options pane will be displayed in the control

Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 1 - Yes.

ShowShading

Integer

No

Returns/sets which parts of the grid will be shaded with color as defined by ShadingBackColor and ShadingForeColor

Possible values for this property are as follows.

  • 0 - None
  • 1 - Foreground (text)
  • 2 - Background (cell)
  • 3 - Both

Default value is 3 - Both, shade both text and cell.

See Shading Colors for more information about color display via this property.

UseFilterConfig

Boolean

No

Returns/sets whether or not to use the configured filter values (FilterConfigXml) to determine what data to display in the control

Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 0 - No.

UsePIT

Boolean

No

Returns/sets whether or not to use the PITDateTime property

Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 0 - No.

See Using the Home Menu for more information about PIT mode.

UseSessionNode

Boolean

No

Returns/sets whether to use the SessionNodeTag property [if set to 1 - Yes] or to present a Chooser page for Node selection [if set to 0 - No] to specify the active Node in the control

Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 1 - Yes for this control

Note: Default value varies by control type.

UseSessionOptions

Boolean

No

Returns/sets whether to use the SessionBeginDate, SessionEndDate, and SessionDateFormat properties [if set to 1 - Yes] in place of the BeginDate, EndDate, and DateFormat properties [if set to 0 - No]

Possible values for this property are as follows.

  • 0 - No
  • 1 - Yes

Default value is 1 - Yes for this control

Note: Default value varies by control type.

Back to top